Deprecate extraQueryParameters #1001
Open
+63
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bgavrilMS
approved these changes
Nov 3, 2025
There was a problem hiding this comment.
Pull Request Overview
This pull request deprecates the extraQueryParameters() method and its builder counterparts across all parameter classes in the MSAL4J SDK. The deprecation indicates that this feature is not recommended for production scenarios and will be removed in a future release, potentially to be replaced by a new API.
- Adds
@Deprecatedannotations to methods and builder methods - Adds consistent deprecation messages across all affected classes
- Updates the interface
IAcquireTokenParameterswhere the method is declared
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| IAcquireTokenParameters.java | Deprecates the extraQueryParameters() method in the interface |
| UserNamePasswordParameters.java | Deprecates getter and builder methods for extra query parameters |
| SilentParameters.java | Deprecates getter and builder methods for extra query parameters |
| RefreshTokenParameters.java | Deprecates getter and builder methods for extra query parameters |
| OnBehalfOfParameters.java | Deprecates getter and builder methods for extra query parameters |
| InteractiveRequestParameters.java | Deprecates getter and builder methods for extra query parameters |
| IntegratedWindowsAuthenticationParameters.java | Deprecates getter and builder methods for extra query parameters |
| DeviceCodeFlowParameters.java | Deprecates getter and builder methods for extra query parameters |
| ClientCredentialParameters.java | Deprecates getter and builder methods for extra query parameters |
| AuthorizationRequestUrlParameters.java | Deprecates getter and builder methods for extra query parameters |
| AuthorizationCodeParameters.java | Deprecates getter and builder methods for extra query parameters |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
4gust
approved these changes
Nov 6, 2025
| /** | ||
| * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API. | ||
| */ | ||
| @Deprecated |
There was a problem hiding this comment.
Should this message be accompanied by the new API? I feel the message is a bit confusing if I am already using this API in production.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Deprecates the extraQueryParameters API according to KR 3310905, similar to what was done in MSAL.NET: AzureAD/microsoft-authentication-library-for-dotnet#5536
This API was meant for niche scenarios which the library did not explicitly cover, and not really meant for production. It can affect the contents and validity of tokens but were not used in our caching scheme which led to bad caching behavior: if the extra query parameters changed between requests we could return tokens that were not valid for the latest set of parameters.
Therefore we are deprecating the current API and, if there is a need for it, may add a new API in the future to perform similar behavior in a more robust way.